Skip to content

docs: ecosystem#391

Merged
dinwwwh merged 1 commit intomainfrom
docs/ecosystem
Apr 11, 2025
Merged

docs: ecosystem#391
dinwwwh merged 1 commit intomainfrom
docs/ecosystem

Conversation

@dinwwwh
Copy link
Copy Markdown
Member

@dinwwwh dinwwwh commented Apr 11, 2025

Summary by CodeRabbit

  • New Features
    • Added an "Ecosystem" link in the navigation, offering quick access to additional project resources.
  • Documentation
    • Introduced a new Ecosystem documentation page featuring resource tables for starter kits and tools, along with a call for community contributions.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 11, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
orpc ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 11, 2025 2:27pm

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 11, 2025

Walkthrough

The changes introduce a new Ecosystem section to the documentation. A navigation item is added in the VitePress configuration, and a corresponding Ecosystem markdown file is created. The markdown page includes introductory details along with tables listing Starter Kits and Tools relevant to the project ecosystem.

Changes

Files Change Summary
apps/content/.vitepress/config.ts, apps/content/docs/ecosystem.md Added an Ecosystem navigation link to the sidebar and created a new Ecosystem documentation page outlining Starter Kits and Tools for the community ecosystem.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant B as Browser
    participant C as VitePress Config
    participant E as Ecosystem Page

    U->>B: Load the website
    B->>C: Retrieve navigation configuration
    C-->>B: Return list of navigation items (incl. Ecosystem)
    U->>B: Click on "Ecosystem" link
    B->>E: Request Ecosystem documentation
    E-->>B: Serve Ecosystem page content
    B-->>U: Render Ecosystem documentation
Loading

Poem

I'm a happy rabbit, hopping through the code,
New docs and navigation lighten up my humble abode.
"Ecosystem" shines on every curious page,
Guiding explorers from start to stage.
With carrots and code, I celebrate this joyful node!
🐇🥕✨

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Apr 11, 2025

More templates

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@391

@orpc/client

npm i https://pkg.pr.new/@orpc/client@391

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@391

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@391

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@391

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@391

@orpc/react

npm i https://pkg.pr.new/@orpc/react@391

@orpc/server

npm i https://pkg.pr.new/@orpc/server@391

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@391

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@391

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@391

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@391

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@391

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@391

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@391

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@391

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@391

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@391

commit: 9112ee9

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
apps/content/docs/ecosystem.md (2)

8-10: Consider making the GitHub link more maintainable

While the direct edit link is helpful for contributions, consider using a more generic link that doesn't hardcode the branch name (currently "main"). This would make the documentation more maintainable across branch changes.

- If your project is missing here, please [open a PR](https://github.com/unnoq/orpc/edit/main/apps/content/docs/ecosystem.md) to add it.
+ If your project is missing here, please [open a PR](https://github.com/unnoq/orpc/blob/HEAD/apps/content/docs/ecosystem.md) to add it.

1-23: Consider adding placeholders for future community contributions

Since this is a newly created ecosystem page with just one entry in each section, consider adding a note encouraging specific types of contributions that would be valuable to the ecosystem, or mentioning that more projects will be added as the community grows.

You could add something like:

## Community
 
As the oRPC ecosystem grows, we welcome contributions in the following areas:

- Client implementations for additional frameworks
- Utility libraries that extend oRPC's functionality
- Example projects showing oRPC in real-world applications

If you're working on something related to oRPC, please share it by adding it to this page!
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 589c5b1 and 9112ee9.

📒 Files selected for processing (2)
  • apps/content/.vitepress/config.ts (1 hunks)
  • apps/content/docs/ecosystem.md (1 hunks)
🔇 Additional comments (4)
apps/content/.vitepress/config.ts (1)

168-168: LGTM: Well-placed ecosystem link in the sidebar

The addition of the ecosystem link in the "Others" section is well-placed and follows the existing navigation pattern consistently. This provides good discoverability for the new ecosystem documentation.

apps/content/docs/ecosystem.md (3)

1-4: LGTM: Clear frontmatter with appropriate title and description

The frontmatter is correctly formatted with a descriptive title and concise description that accurately represents the page's content.


14-16: LGTM: Well-structured Starter Kits table

The table structure is clear and provides valuable information about each starter kit. The inclusion of GitHub stars adds credibility to the listed projects.


20-22: LGTM: Informative Tools table

The tools table follows the same clear structure as the Starter Kits table, providing consistent information across the ecosystem page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant